<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    package org.hackystat.utilities.logger;<a name="line.1"></a>
<FONT color="green">002</FONT>    <a name="line.2"></a>
<FONT color="green">003</FONT>    import java.io.File;<a name="line.3"></a>
<FONT color="green">004</FONT>    import java.io.IOException;<a name="line.4"></a>
<FONT color="green">005</FONT>    import java.util.logging.ConsoleHandler;<a name="line.5"></a>
<FONT color="green">006</FONT>    import java.util.logging.FileHandler;<a name="line.6"></a>
<FONT color="green">007</FONT>    import java.util.logging.Handler;<a name="line.7"></a>
<FONT color="green">008</FONT>    import java.util.logging.Level;<a name="line.8"></a>
<FONT color="green">009</FONT>    import java.util.logging.LogManager;<a name="line.9"></a>
<FONT color="green">010</FONT>    import java.util.logging.Logger;<a name="line.10"></a>
<FONT color="green">011</FONT>    <a name="line.11"></a>
<FONT color="green">012</FONT>    import org.hackystat.utilities.home.HackystatUserHome;<a name="line.12"></a>
<FONT color="green">013</FONT>    <a name="line.13"></a>
<FONT color="green">014</FONT>    <a name="line.14"></a>
<FONT color="green">015</FONT>    /**<a name="line.15"></a>
<FONT color="green">016</FONT>     * Supports logging of informational and error messages by a service.<a name="line.16"></a>
<FONT color="green">017</FONT>     * Uses HackystatUserHome.getHome() to determine where to put the logs directory.<a name="line.17"></a>
<FONT color="green">018</FONT>     * @author Philip Johnson<a name="line.18"></a>
<FONT color="green">019</FONT>     */<a name="line.19"></a>
<FONT color="green">020</FONT>    public final class HackystatLogger {<a name="line.20"></a>
<FONT color="green">021</FONT>      <a name="line.21"></a>
<FONT color="green">022</FONT>    <a name="line.22"></a>
<FONT color="green">023</FONT>      /**<a name="line.23"></a>
<FONT color="green">024</FONT>       * Create a new Logger for Hackystat.  <a name="line.24"></a>
<FONT color="green">025</FONT>       *<a name="line.25"></a>
<FONT color="green">026</FONT>       * @param loggerName The name of the logger to create.<a name="line.26"></a>
<FONT color="green">027</FONT>       * @param subdir If non-null, then logging files are placed in .hackystat/[subdir]/logs.<a name="line.27"></a>
<FONT color="green">028</FONT>       * Otherwise they are placed in .hackystat/logs.<a name="line.28"></a>
<FONT color="green">029</FONT>       * @param hasConsole If true, then a ConsoleHandler is created.<a name="line.29"></a>
<FONT color="green">030</FONT>       */<a name="line.30"></a>
<FONT color="green">031</FONT>      private HackystatLogger(String loggerName, String subdir, boolean hasConsole) {<a name="line.31"></a>
<FONT color="green">032</FONT>        Logger logger = Logger.getLogger(loggerName);<a name="line.32"></a>
<FONT color="green">033</FONT>        logger.setUseParentHandlers(false);<a name="line.33"></a>
<FONT color="green">034</FONT>    <a name="line.34"></a>
<FONT color="green">035</FONT>        // Define a file handler that writes to the ~/.hackystat/logs directory, creating it if nec.<a name="line.35"></a>
<FONT color="green">036</FONT>        String logSubDir = (subdir == null) ? ".hackystat/logs/" : ".hackystat/" + subdir + "/logs/";<a name="line.36"></a>
<FONT color="green">037</FONT>        File logDir = new File(HackystatUserHome.getHome(), logSubDir);<a name="line.37"></a>
<FONT color="green">038</FONT>        boolean dirsOk = logDir.mkdirs();<a name="line.38"></a>
<FONT color="green">039</FONT>        if (!dirsOk &amp;&amp; !logDir.exists()) {<a name="line.39"></a>
<FONT color="green">040</FONT>          throw new RuntimeException("mkdirs() failed");<a name="line.40"></a>
<FONT color="green">041</FONT>        }<a name="line.41"></a>
<FONT color="green">042</FONT>        String fileName = logDir + "/" + loggerName + ".%u.log";<a name="line.42"></a>
<FONT color="green">043</FONT>        FileHandler fileHandler;<a name="line.43"></a>
<FONT color="green">044</FONT>        try {<a name="line.44"></a>
<FONT color="green">045</FONT>          fileHandler = new FileHandler(fileName, 500000, 1, true);<a name="line.45"></a>
<FONT color="green">046</FONT>          fileHandler.setFormatter(new OneLineFormatter());<a name="line.46"></a>
<FONT color="green">047</FONT>          logger.addHandler(fileHandler);<a name="line.47"></a>
<FONT color="green">048</FONT>        }<a name="line.48"></a>
<FONT color="green">049</FONT>        catch (IOException e) {<a name="line.49"></a>
<FONT color="green">050</FONT>          throw new RuntimeException("Could not open the log file for this Hackystat service.", e);<a name="line.50"></a>
<FONT color="green">051</FONT>        }<a name="line.51"></a>
<FONT color="green">052</FONT>    <a name="line.52"></a>
<FONT color="green">053</FONT>        // Define a console handler to also write the message to the console.<a name="line.53"></a>
<FONT color="green">054</FONT>        if (hasConsole) {<a name="line.54"></a>
<FONT color="green">055</FONT>          ConsoleHandler consoleHandler = new ConsoleHandler();<a name="line.55"></a>
<FONT color="green">056</FONT>          consoleHandler.setFormatter(new OneLineFormatter());<a name="line.56"></a>
<FONT color="green">057</FONT>          logger.addHandler(consoleHandler);<a name="line.57"></a>
<FONT color="green">058</FONT>        }<a name="line.58"></a>
<FONT color="green">059</FONT>        setLoggingLevel(logger, "INFO");<a name="line.59"></a>
<FONT color="green">060</FONT>      }<a name="line.60"></a>
<FONT color="green">061</FONT>    <a name="line.61"></a>
<FONT color="green">062</FONT>      <a name="line.62"></a>
<FONT color="green">063</FONT>      /**<a name="line.63"></a>
<FONT color="green">064</FONT>       * Return the Hackystat Logger named with loggerName, creating it if it does not yet exist.<a name="line.64"></a>
<FONT color="green">065</FONT>       * Hackystat loggers have the following characteristics:<a name="line.65"></a>
<FONT color="green">066</FONT>       * &lt;ul&gt;<a name="line.66"></a>
<FONT color="green">067</FONT>       * &lt;li&gt; Log messages are one line and are prefixed with a time stamp using the OneLineFormatter<a name="line.67"></a>
<FONT color="green">068</FONT>       * class.<a name="line.68"></a>
<FONT color="green">069</FONT>       * &lt;li&gt; The logger creates a Console logger and a File logger. <a name="line.69"></a>
<FONT color="green">070</FONT>       * &lt;li&gt; The File logger is written out to the ~/.hackystat/logs/ directory, creating this if<a name="line.70"></a>
<FONT color="green">071</FONT>       * it is not found.<a name="line.71"></a>
<FONT color="green">072</FONT>       * &lt;li&gt; The File log name is {name}.%u.log.<a name="line.72"></a>
<FONT color="green">073</FONT>       * &lt;/ul&gt; <a name="line.73"></a>
<FONT color="green">074</FONT>       * @param loggerName The name of this HackystatLogger.<a name="line.74"></a>
<FONT color="green">075</FONT>       * @return The Logger instance. <a name="line.75"></a>
<FONT color="green">076</FONT>       */<a name="line.76"></a>
<FONT color="green">077</FONT>      public static Logger getLogger(String loggerName) {<a name="line.77"></a>
<FONT color="green">078</FONT>        return HackystatLogger.getLogger(loggerName, null, true);<a name="line.78"></a>
<FONT color="green">079</FONT>      }<a name="line.79"></a>
<FONT color="green">080</FONT>      <a name="line.80"></a>
<FONT color="green">081</FONT>      /**<a name="line.81"></a>
<FONT color="green">082</FONT>       * Return the Hackystat Logger named with loggerName, creating it if it does not yet exist.<a name="line.82"></a>
<FONT color="green">083</FONT>       * Hackystat loggers have the following characteristics:<a name="line.83"></a>
<FONT color="green">084</FONT>       * &lt;ul&gt;<a name="line.84"></a>
<FONT color="green">085</FONT>       * &lt;li&gt; Log messages are one line and are prefixed with a time stamp using the OneLineFormatter<a name="line.85"></a>
<FONT color="green">086</FONT>       * class.<a name="line.86"></a>
<FONT color="green">087</FONT>       * &lt;li&gt; The logger creates a Console logger and a File logger. <a name="line.87"></a>
<FONT color="green">088</FONT>       * &lt;li&gt; The File logger is written out to the ~/.hackystat/[subDir]/logs/ directory, creating <a name="line.88"></a>
<FONT color="green">089</FONT>       * this if it is not found.<a name="line.89"></a>
<FONT color="green">090</FONT>       * &lt;li&gt; The File log name is {name}.%u.log.<a name="line.90"></a>
<FONT color="green">091</FONT>       * &lt;/ul&gt; <a name="line.91"></a>
<FONT color="green">092</FONT>       * @param loggerName The name of this HackystatLogger.<a name="line.92"></a>
<FONT color="green">093</FONT>       * @param subDir The .hackystat subdirectory in which the log/ directory should be put.<a name="line.93"></a>
<FONT color="green">094</FONT>       * @return The Logger instance. <a name="line.94"></a>
<FONT color="green">095</FONT>       */<a name="line.95"></a>
<FONT color="green">096</FONT>      public static Logger getLogger(String loggerName, String subDir) {<a name="line.96"></a>
<FONT color="green">097</FONT>        return getLogger(loggerName, subDir, true);<a name="line.97"></a>
<FONT color="green">098</FONT>      }<a name="line.98"></a>
<FONT color="green">099</FONT>      <a name="line.99"></a>
<FONT color="green">100</FONT>      /**<a name="line.100"></a>
<FONT color="green">101</FONT>       * Return the Hackystat Logger named with loggerName, creating it if it does not yet exist.<a name="line.101"></a>
<FONT color="green">102</FONT>       * Hackystat loggers have the following characteristics:<a name="line.102"></a>
<FONT color="green">103</FONT>       * &lt;ul&gt;<a name="line.103"></a>
<FONT color="green">104</FONT>       * &lt;li&gt; Log messages are one line and are prefixed with a time stamp using the OneLineFormatter<a name="line.104"></a>
<FONT color="green">105</FONT>       * class.<a name="line.105"></a>
<FONT color="green">106</FONT>       * &lt;li&gt; The logger creates a File logger. <a name="line.106"></a>
<FONT color="green">107</FONT>       * &lt;li&gt; The File logger is written out to the ~/.hackystat/[subDir]/logs/ directory, creating <a name="line.107"></a>
<FONT color="green">108</FONT>       * this if it is not found.<a name="line.108"></a>
<FONT color="green">109</FONT>       * &lt;li&gt; The File log name is {name}.%u.log.<a name="line.109"></a>
<FONT color="green">110</FONT>       * &lt;li&gt; There is also a ConsoleHandler (if hasConsole is true).<a name="line.110"></a>
<FONT color="green">111</FONT>       * &lt;/ul&gt; <a name="line.111"></a>
<FONT color="green">112</FONT>       * @param loggerName The name of this HackystatLogger.<a name="line.112"></a>
<FONT color="green">113</FONT>       * @param subDir The .hackystat subdirectory in which the log/ directory should be put.<a name="line.113"></a>
<FONT color="green">114</FONT>       * @param hasConsole If true, then a ConsoleHandler is created. <a name="line.114"></a>
<FONT color="green">115</FONT>       * @return The Logger instance. <a name="line.115"></a>
<FONT color="green">116</FONT>       */<a name="line.116"></a>
<FONT color="green">117</FONT>      public static Logger getLogger(String loggerName, String subDir, boolean hasConsole) {<a name="line.117"></a>
<FONT color="green">118</FONT>        Logger logger = LogManager.getLogManager().getLogger(loggerName);<a name="line.118"></a>
<FONT color="green">119</FONT>        if (logger == null) {<a name="line.119"></a>
<FONT color="green">120</FONT>          new HackystatLogger(loggerName, subDir, hasConsole);<a name="line.120"></a>
<FONT color="green">121</FONT>        }<a name="line.121"></a>
<FONT color="green">122</FONT>        return LogManager.getLogManager().getLogger(loggerName);<a name="line.122"></a>
<FONT color="green">123</FONT>      }<a name="line.123"></a>
<FONT color="green">124</FONT>    <a name="line.124"></a>
<FONT color="green">125</FONT>    <a name="line.125"></a>
<FONT color="green">126</FONT>      /**<a name="line.126"></a>
<FONT color="green">127</FONT>       * Sets the logging level to be used for this Hackystat logger.<a name="line.127"></a>
<FONT color="green">128</FONT>       * If the passed string cannot be parsed into a Level, then INFO is set by default.<a name="line.128"></a>
<FONT color="green">129</FONT>       * @param logger The logger whose level is to be set.  <a name="line.129"></a>
<FONT color="green">130</FONT>       * @param level The new Level.<a name="line.130"></a>
<FONT color="green">131</FONT>       */<a name="line.131"></a>
<FONT color="green">132</FONT>      public static void setLoggingLevel(Logger logger, String level) {<a name="line.132"></a>
<FONT color="green">133</FONT>        Level newLevel = Level.INFO;<a name="line.133"></a>
<FONT color="green">134</FONT>        try {<a name="line.134"></a>
<FONT color="green">135</FONT>          newLevel = Level.parse(level);<a name="line.135"></a>
<FONT color="green">136</FONT>        }<a name="line.136"></a>
<FONT color="green">137</FONT>        catch (Exception e) {<a name="line.137"></a>
<FONT color="green">138</FONT>          logger.info("Couldn't set Logging level to: " + level);<a name="line.138"></a>
<FONT color="green">139</FONT>        }<a name="line.139"></a>
<FONT color="green">140</FONT>        logger.setLevel(newLevel);<a name="line.140"></a>
<FONT color="green">141</FONT>        for (Handler handler : logger.getHandlers()) {<a name="line.141"></a>
<FONT color="green">142</FONT>          handler.setLevel(newLevel);<a name="line.142"></a>
<FONT color="green">143</FONT>        }<a name="line.143"></a>
<FONT color="green">144</FONT>      }<a name="line.144"></a>
<FONT color="green">145</FONT>    }<a name="line.145"></a>
<FONT color="green">146</FONT>    <a name="line.146"></a>




























































</PRE>
</BODY>
</HTML>
